<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.6.1" />

	<title>Interface IDibiDriver | Dibi 2.0.2 API documentation</title>

	<script type="text/javascript" src="resources/combined.js?3201557540"></script>
	<script type="text/javascript" src="elementlist.js?236042691"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1321461267" />
	<link rel="search" type="application/opensearchdescription+xml" title="Dibi 2.0.2 API documentation" href="http://api.dibiphp.com/2.0/opensearch.xml" />

</head>

<body>
<div id="left">
	<div id="menu">

		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li class="active"><a href="package-dibi.html">dibi<span></span></a>
						<ul>
				<li><a href="package-dibi.drivers.html">drivers</a>
						</li>
				<li><a href="package-dibi.nette.html">nette</a>
						</li>
				<li><a href="package-dibi.reflection.html">reflection</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="dibi.html">dibi</a></li>
				<li><a href="DibiConnection.html">DibiConnection</a></li>
				<li><a href="DibiDataSource.html">DibiDataSource</a></li>
				<li><a href="DibiDateTime.html">DibiDateTime</a></li>
				<li><a href="DibiEvent.html">DibiEvent</a></li>
				<li><a href="DibiFileLogger.html">DibiFileLogger</a></li>
				<li><a href="DibiFirePhpLogger.html">DibiFirePhpLogger</a></li>
				<li><a href="DibiFluent.html">DibiFluent</a></li>
				<li><a href="DibiObject.html">DibiObject</a></li>
				<li><a href="DibiResult.html">DibiResult</a></li>
				<li><a href="DibiResultIterator.html">DibiResultIterator</a></li>
				<li><a href="DibiRow.html">DibiRow</a></li>
				<li><a href="DibiTranslator.html">DibiTranslator</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="IDataSource.html">IDataSource</a></li>
				<li class="active"><a href="IDibiDriver.html">IDibiDriver</a></li>
				<li><a href="IDibiReflector.html">IDibiReflector</a></li>
				<li><a href="IDibiResultDriver.html">IDibiResultDriver</a></li>
			</ul>


			<h3>Exceptions</h3>
			<ul>
				<li><a href="DibiDriverException.html">DibiDriverException</a></li>
				<li><a href="DibiException.html">DibiException</a></li>
				<li><a href="DibiNotImplementedException.html">DibiNotImplementedException</a></li>
				<li><a href="DibiNotSupportedException.html">DibiNotSupportedException</a></li>
				<li><a href="DibiPcreException.html">DibiPcreException</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form action="http://www.google.com/cse" id="search">
		<input type="hidden" name="cx" value="011549293477758430224:x_apk4yrmjm" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="hidden" name="more" value="api" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-dibi.html" title="Summary of dibi"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Interface IDibiDriver</h1>


	<div class="description">
	
<p>dibi driver interface.</p>

	</div>





	<div>
		<h4>Direct known implementers</h4>
			<a href="DibiFirebirdDriver.html">DibiFirebirdDriver</a>, 
			<a href="DibiMsSql2005Driver.html">DibiMsSql2005Driver</a>, 
			<a href="DibiSqliteDriver.html">DibiSqliteDriver</a>, 
			<a href="DibiMsSqlDriver.html">DibiMsSqlDriver</a>, 
			<a href="DibiMySqlDriver.html">DibiMySqlDriver</a>, 
			<a href="DibiMySqliDriver.html">DibiMySqliDriver</a>, 
			<a href="DibiOdbcDriver.html">DibiOdbcDriver</a>, 
			<a href="DibiOracleDriver.html">DibiOracleDriver</a>, 
			<a href="DibiPdoDriver.html">DibiPdoDriver</a>, 
			<a href="DibiPostgreDriver.html">DibiPostgreDriver</a>, 
			<a href="DibiSqlite3Driver.html">DibiSqlite3Driver</a>
	</div>




	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-dibi.html">dibi</a><br />

		<b>Located at</b> <a href="source-libs.interfaces.php.html#26" title="Go to source code">libs/interfaces.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="connect" id="_connect">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_connect">#</a>
		<code><a href="source-libs.interfaces.php.html#33" title="Go to source code">connect</a>( <span>array <var>&amp; $config</var></span> )</code>

		<div class="description short">
			
<p>Connects to a database.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Connects to a database.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$config</var></dt>
					<dd><code>array</code></dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiException.html">DibiException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="disconnect" id="_disconnect">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_disconnect">#</a>
		<code><a href="source-libs.interfaces.php.html#41" title="Go to source code">disconnect</a>( )</code>

		<div class="description short">
			
<p>Disconnects from a database.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Disconnects from a database.</p>





				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiException.html">DibiException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="query" id="_query">

		<td class="attributes"><code>
			 public 
			<code><a href="IDibiResultDriver.html">IDibiResultDriver</a></code>|null
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_query">#</a>
		<code><a href="source-libs.interfaces.php.html#48" title="Go to source code">query</a>( <span>string <var>$sql</var></span> )</code>

		<div class="description short">
			
<p>Internal: Executes the SQL query.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Internal: Executes the SQL query.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sql</var></dt>
					<dd><code>string</code><br>SQL statement.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code><code><a href="IDibiResultDriver.html">IDibiResultDriver</a></code>|null</code><br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiDriverException.html">DibiDriverException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getAffectedRows" id="_getAffectedRows">

		<td class="attributes"><code>
			 public 
			integer|false
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getAffectedRows">#</a>
		<code><a href="source-libs.interfaces.php.html#56" title="Go to source code">getAffectedRows</a>( )</code>

		<div class="description short">
			
<p>Gets the number of affected rows by the last INSERT, UPDATE or DELETE
query.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Gets the number of affected rows by the last INSERT, UPDATE or DELETE
query.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer|false</code><br>number of rows or FALSE on error<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="getInsertId" id="_getInsertId">

		<td class="attributes"><code>
			 public 
			integer|false
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getInsertId">#</a>
		<code><a href="source-libs.interfaces.php.html#62" title="Go to source code">getInsertId</a>( <span> <var>$sequence</var></span> )</code>

		<div class="description short">
			
<p>Retrieves the ID generated for an AUTO_INCREMENT column by the previous
INSERT query.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Retrieves the ID generated for an AUTO_INCREMENT column by the previous
INSERT query.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>integer|false</code><br>int on success or FALSE on failure<br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="begin" id="_begin">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_begin">#</a>
		<code><a href="source-libs.interfaces.php.html#68" title="Go to source code">begin</a>( <span>string <var>$savepoint</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Begins a transaction (if supported).</p>

		</div>

		<div class="description detailed hidden">
			
<p>Begins a transaction (if supported).</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$savepoint</var></dt>
					<dd><code>string</code><br>optional savepoint name</dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiDriverException.html">DibiDriverException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="commit" id="_commit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_commit">#</a>
		<code><a href="source-libs.interfaces.php.html#76" title="Go to source code">commit</a>( <span>string <var>$savepoint</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Commits statements in a transaction.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Commits statements in a transaction.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$savepoint</var></dt>
					<dd><code>string</code><br>optional savepoint name</dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiDriverException.html">DibiDriverException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="rollback" id="_rollback">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_rollback">#</a>
		<code><a href="source-libs.interfaces.php.html#84" title="Go to source code">rollback</a>( <span>string <var>$savepoint</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Rollback changes in a transaction.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Rollback changes in a transaction.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$savepoint</var></dt>
					<dd><code>string</code><br>optional savepoint name</dd>
				</dl></div>


				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="DibiDriverException.html">DibiDriverException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getResource" id="_getResource">

		<td class="attributes"><code>
			 public 
			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getResource">#</a>
		<code><a href="source-libs.interfaces.php.html#92" title="Go to source code">getResource</a>( )</code>

		<div class="description short">
			
<p>Returns the connection resource.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns the connection resource.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>mixed</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="getReflector" id="_getReflector">

		<td class="attributes"><code>
			 public 
			<code><a href="IDibiReflector.html">IDibiReflector</a></code>
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getReflector">#</a>
		<code><a href="source-libs.interfaces.php.html#98" title="Go to source code">getReflector</a>( )</code>

		<div class="description short">
			
<p>Returns the connection reflector.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Returns the connection reflector.</p>




				<h4>Returns</h4>
				<div class="list">
					<code><code><a href="IDibiReflector.html">IDibiReflector</a></code></code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="escape" id="_escape">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_escape">#</a>
		<code><a href="source-libs.interfaces.php.html#104" title="Go to source code">escape</a>( <span>string <var>$value</var></span>, <span>string <var>$type</var></span> )</code>

		<div class="description short">
			
<p>Encodes data for use in a SQL statement.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Encodes data for use in a SQL statement.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$value</var></dt>
					<dd><code>string</code><br>value</dd>
					<dt><var>$type</var></dt>
					<dd><code>string</code><br>type (dibi::TEXT, dibi::BOOL, ...)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br>encoded value<br />
				</div>

				<h4>Throws</h4>
				<div class="list">
					<code><code><a href="InvalidArgumentException.html">InvalidArgumentException</a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="escapeLike" id="_escapeLike">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_escapeLike">#</a>
		<code><a href="source-libs.interfaces.php.html#113" title="Go to source code">escapeLike</a>( <span>string <var>$value</var></span>, <span>integer <var>$pos</var></span> )</code>

		<div class="description short">
			
<p>Encodes string for use in a LIKE statement.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Encodes string for use in a LIKE statement.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$value</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$pos</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>



		</div>
		</div></td>
	</tr>
	<tr data-order="applyLimit" id="_applyLimit">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_applyLimit">#</a>
		<code><a href="source-libs.interfaces.php.html#121" title="Go to source code">applyLimit</a>( <span>string <var>&amp; $sql</var></span>, <span>integer <var>$limit</var></span>, <span>integer <var>$offset</var></span> )</code>

		<div class="description short">
			
<p>Injects LIMIT/OFFSET to the SQL query.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Injects LIMIT/OFFSET to the SQL query.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sql</var></dt>
					<dd><code>string</code><br>&amp;$sql The SQL query that will be modified.</dd>
					<dt><var>$limit</var></dt>
					<dd><code>integer</code></dd>
					<dt><var>$offset</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>




		</div>
		</div></td>
	</tr>
	</table>










</div>

	<div id="footer">
		Dibi 2.0.2 API documentation API documentation generated by <a href="http://apigen.org">ApiGen 2.6.1</a>
	</div>
</div>
</div>
</body>
</html>
